<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow: async/single_thread_task_loop.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow<span id="projectnumber">&#160;2.0.0</span>
   </div>
   <div id="projectbrief">Flow project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_ddc98e6e1a9e0f6adcacab8ac7c1f855.html">async</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">single_thread_task_loop.hpp</div></div>
</div><!--header-->
<div class="contents">
<a href="single__thread__task__loop_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/* Flow</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> * Copyright 2023 Akamai Technologies, Inc.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> *</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> * Licensed under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> * &quot;License&quot;); you may not use this file except in</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment"> * compliance with the License.  You may obtain a copy</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment"> * of the License at</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment"> *</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment"> *   https://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment"> *</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment"> * Unless required by applicable law or agreed to in</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment"> * writing, software distributed under the License is</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment"> * distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment"> * CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment"> * See the License for the specific language governing</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment"> * permissions and limitations under the License. */</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment"></span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="comment">/// @file</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="comment"></span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="preprocessor">#include &quot;<a class="code" href="async__fwd_8hpp.html">flow/async/async_fwd.hpp</a>&quot;</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="preprocessor">#include &quot;<a class="code" href="x__thread__task__loop_8hpp.html">flow/async/x_thread_task_loop.hpp</a>&quot;</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span><span class="preprocessor">#include &quot;<a class="code" href="timed__concurrent__task__loop_8hpp.html">flow/async/timed_concurrent_task_loop.hpp</a>&quot;</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="preprocessor">#include &quot;<a class="code" href="clock__type__fwd_8hpp.html">flow/perf/clock_type_fwd.hpp</a>&quot;</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="preprocessor">#include &quot;<a class="code" href="util_2util_8hpp.html">flow/util/util.hpp</a>&quot;</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceflow_1_1async.html">flow::async</a></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span>{</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span><span class="comment"></span> </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span><span class="comment">/**</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span><span class="comment"> * A `Concurrent_task_loop`-related adapter-style class that represents a single-thread task loop; essentially</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span><span class="comment"> * it is pleasant syntactic sugar around a Concurrent_task_loop impl that cuts out concepts that become irrelevant</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span><span class="comment"> * with only one thread involved.</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span><span class="comment"> *</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span><span class="comment"> * ### Thread safety ###</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span><span class="comment"> * All methods are thread-safe for read-write on a shared Single_thread_task_loop, after its ctor returns, unless</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span><span class="comment"> * otherwise specified (but read on).  This is highly significant, just as it is highly significant that boost.asio&#39;s</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span><span class="comment"> * `post(Task_engine&amp;)` is similarly thread-safe.  However, it is *not* safe to call either stop() or start()</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span><span class="comment"> * concurrently with itself or the other of the two, on the same Single_thread_task_loop.</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span><span class="comment"> *</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span><span class="comment"> * ### Rationale ###</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span><span class="comment"> * A single-thread task/event loop is very common; arguably more common than multi-threaded.  While</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span><span class="comment"> * the Concurrent_task_loop hierarchy&#39;s value is things like async::Op (strand/etc.) support, which are multi-threaded</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span><span class="comment"> * by definition, it also provides significant value via setup/teardown of a thread in a consistent way and other</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span><span class="comment"> * features that aren&#39;t related to concurrency.  The author (ygoldfel) therefore kept wanting to use</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span><span class="comment"> * Concurrent_task_loop hierarchy for single-thread loops; and immediately realized in particular that the 2 choices</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span><span class="comment"> * of impl -- Cross_thread_task_loop and Segregated_thread_task_loop -- become almost bit-wise-identical to each other</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span><span class="comment"> * internally when only 1 thread is involved.  Therefore the choice of which one to use felt silly.  Moreover</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span><span class="comment"> * both of those classes have internal optimizations when `n_threads_or_zero == 1`.</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span><span class="comment"> *</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span><span class="comment"> * So then the author decided to make this class to eliminate having to make this silly choice, when all the needs</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span><span class="comment"> * are already met regardless of the choice made.  It is similar to how `std::queue&lt;T&gt;` is a limited `deque&lt;T&gt;` or</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span><span class="comment"> * `list&lt;T&gt;`; though arguably even more straightforward, because in our case it makes no difference which underlying</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span><span class="comment"> * class is used (with `queue&lt;T&gt;` it does).  In any case, that&#39;s why there&#39;s no template parameter for the</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span><span class="comment"> * underlying impl class in our case (could change in the future).</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span><span class="comment"> *</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span><span class="comment"> * @internal</span></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span><span class="comment"> * ### Implementation notes / rationale ###</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span><span class="comment"> * In the past Single_thread_task_loop `private`ly inherited from Cross_thread_task_loop.  Now it simple stores one</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span><span class="comment"> * as a member (composition).   In both cases it&#39;s a HAS-A relationship, so the diffence is a question of syntactic</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span><span class="comment"> * sugar and not conceptual.  The reason I (ygoldfel) originally used `private` inheritance was purely for</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span><span class="comment"> * brevity: one could, e.g., write `using Task_loop_impl::stop;` instead of writing a trivial body that just</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span><span class="comment"> * forwarded to that super-method.  The reason I switched to composition was Timed_single_thread_task_loop appeared,</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span><span class="comment"> * which made it desirable to make methods like post() `virtual` -- meaning to *start* a `virtual` hierarchy</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span><span class="comment"> * of (some) similarly-named methods, so that Single_thread_task_loop::post() would be `virtual`, and</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span><span class="comment"> * Timed_single_thread_task_loop::post() would `override` it.  This is when trouble started: due to inheriting</span></div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span><span class="comment"> * from a Concurrent_task_loop with a `virtual` method also named `post()`,</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span><span class="comment"> * `static_cast&lt;Concurrent_task_loop*&gt;(this)-&gt;post()` -- necessary in Timed_single_thread_task_loop for certain</span></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span><span class="comment"> * internal reasons -- `virtual` resolution followed the chain down through the `private` inheritance and ended up</span></div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span><span class="comment"> * invoking Single_thread_task_loop::post() and hence Timed_single_thread_task_loop::post() again, leading to</span></div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span><span class="comment"> * infinite recursion.  In other words, making Single_thread_task_loop::post() `virtual` *continued* the `virtual`</span></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span><span class="comment"> * chain of `post()` methods, instead of starting a new chain as planned, even though the inheritance is `private`.</span></div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span><span class="comment"> * At that point it seemed better -- if a little less pithy -- to give up on that and just use composition.</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span><span class="comment"> */</span></div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"><a class="line" href="classflow_1_1async_1_1Single__thread__task__loop.html">   75</a></span><span class="keyword">class </span><a class="code hl_class" href="classflow_1_1async_1_1Single__thread__task__loop.html">Single_thread_task_loop</a> :</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span>  <span class="keyword">public</span> <a class="code hl_class" href="classflow_1_1log_1_1Log__context.html">log::Log_context</a>, <span class="comment">// We log a bit.</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span>  <span class="keyword">public</span> <a class="code hl_class" href="classflow_1_1util_1_1Null__interface.html">util::Null_interface</a> <span class="comment">// We have some virtual things.</span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span>{</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno">   80</span>  <span class="comment">// Constructors/destructor.</span></div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno">   81</span><span class="comment"></span> </div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span><span class="comment">   * Constructs object, making it available for post() and similar work, but without starting any thread and hence</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span><span class="comment">   * without the ability to perform any work; call start() to spawn 1 thread and perform work.</span></div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span><span class="comment">   *</span></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span><span class="comment">   * @param logger_ptr</span></div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno">   87</span><span class="comment">   *        Logger to use for subsequently logging.</span></div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span><span class="comment">   * @param nickname</span></div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span><span class="comment">   *        Brief, human-readable nickname of the new loop/thread, as of this writing for logging only.</span></div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span><span class="comment">   */</span></div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span>  <span class="keyword">explicit</span> <a class="code hl_function" href="classflow_1_1async_1_1Single__thread__task__loop.html#aea2bba204b5d18c3f87d05a4ca19a13f">Single_thread_task_loop</a>(<a class="code hl_class" href="classflow_1_1log_1_1Logger.html">log::Logger</a>* logger_ptr, <a class="code hl_typedef" href="namespaceflow_1_1util.html#ae4dc52186797094b3040379ff19124c9">util::String_view</a> nickname);</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span><span class="comment"></span> </div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span><span class="comment">   * Executes stop() -- see its doc header please -- and then cleans up any resources.</span></div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span><span class="comment">   * The behavior of stop() has subtle implications, so please be sure to understand what it does.</span></div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno">   96</span><span class="comment">   *</span></div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno">   97</span><span class="comment">   * It is fine if stop() has already been called and returned.</span></div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span><span class="comment">   */</span></div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno">   99</span>  <a class="code hl_function" href="classflow_1_1async_1_1Single__thread__task__loop.html#a74f7b9eabdfc366e0a6fa46abbcf5047">~Single_thread_task_loop</a>() <span class="keyword">override</span>;</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno">  100</span> </div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno">  101</span>  <span class="comment">// Methods.</span></div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno">  102</span><span class="comment"></span> </div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno">  104</span><span class="comment">   * Starts the 1 thread in the thread pool; any queued `post()`ed (and similar) tasks may begin executing immediately;</span></div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span><span class="comment">   * and any future posted work may execute in this thread.  Calling start() after start() is discouraged and may</span></div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span><span class="comment">   * log a WARNING but is a harmless no-op.  See also stop().</span></div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno">  107</span><span class="comment">   *</span></div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno">  108</span><span class="comment">   * The optional `init_task_or_empty` arg is a convenience thing.  It&#39;s equivalent to</span></div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span><span class="comment">   * `post(init_task_or_empty, Synchronicity::S_ASYNC_AND_AWAIT_CONCURRENT_COMPLETION)` executed upon return.</span></div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span><span class="comment">   * `init_task_or_empty()` will run in the new thread; and only once it `return`s, start() will `return`.</span></div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno">  111</span><span class="comment">   * Rationale: It has come up in our experience several times that one wants to execute something in the new thread</span></div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno">  112</span><span class="comment">   * to initialize things, synchronously, before the main work -- various async `post()`ing and other calls -- can begin</span></div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno">  113</span><span class="comment">   * in earnest.  Do note that any tasks enqueued before this start() but after the last stop() or constructor</span></div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno">  114</span><span class="comment">   * may run first.</span></div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno">  115</span><span class="comment">   *</span></div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno">  116</span><span class="comment">   * The worker thread started will exit upon any uncaught exception by one</span></div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno">  117</span><span class="comment">   * of the user-supplied tasks posted onto it subsequently.  If this occurs, the handler will `exit()` the entire</span></div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno">  118</span><span class="comment">   * program with a non-zero code after logging the exception message.  (It is informally recommended that all other</span></div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno">  119</span><span class="comment">   * threads in the application do the same.)</span></div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno">  120</span><span class="comment">   *</span></div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno">  121</span><span class="comment">   * Assuming no such uncaught exception is thrown, all threads will run until stop() or the destructor runs and</span></div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno">  122</span><span class="comment">   * returns.</span></div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno">  123</span><span class="comment">   *</span></div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno">  124</span><span class="comment">   * ### Thread safety ###</span></div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno">  125</span><span class="comment">   * All methods are thread-safe on a common `*this` unless noted otherwise.</span></div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno">  126</span><span class="comment">   * To wit: it is not safe to call `X.start()` concurrently with `X.start()` or with `X.stop()`.</span></div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno">  127</span><span class="comment">   *</span></div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno">  128</span><span class="comment">   * ### Implementation ###</span></div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno">  129</span><span class="comment">   * In this implementation start() essentially involves a single `Task_engine::restart()`,</span></div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno">  130</span><span class="comment">   * followed by starting 1 thread, that thread executing a long-running `Task_engine::run()`.</span></div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno">  131</span><span class="comment">   *</span></div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno">  132</span><span class="comment">   * ### Rationale for omitting counterpart to Concurrent_task_loop::start() `thread_init_func_or_empty` arg ###</span></div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno">  133</span><span class="comment">   * `init_task_or_empty` is sufficient, as there is only one thread.  The `thread_init_func_or_empty` guarantee</span></div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno">  134</span><span class="comment">   * that it run *first-thing* in the thread is too subtle to worry about in practice; `init_task_or_empty` is fine.</span></div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno">  135</span><span class="comment">   *</span></div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno">  136</span><span class="comment">   * @param init_task_or_empty</span></div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno">  137</span><span class="comment">   *        Ignored if `.empty()` (the default).  Otherwise `init_task_or_empty()` shall execute in the</span></div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno">  138</span><span class="comment">   *        thread started by this method, delaying the method&#39;s return to the caller until `init_task_or_empty()`</span></div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno">  139</span><span class="comment">   *        returns in said spawned thread.</span></div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno">  140</span><span class="comment">   */</span></div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno">  141</span>  <span class="keywordtype">void</span> <a class="code hl_function" href="classflow_1_1async_1_1Single__thread__task__loop.html#a0886e7f19d0c8b19f74851578802a5e5">start</a>(<a class="code hl_class" href="classflow_1_1Function.html">Task</a>&amp;&amp; init_task_or_empty = <a class="code hl_typedef" href="namespaceflow_1_1async.html#af35fb65bdea1a3a92929ec2c4a6a6b72">Task</a>());</div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno">  142</span><span class="comment"></span> </div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno">  143</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno">  144</span><span class="comment">   * Waits for the ongoing task/completion handler -- if one is running -- to return; then prevents any further-queued</span></div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno">  145</span><span class="comment">   * such tasks from running; then gracefully stops/joins the worker thread; and then returns.</span></div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno">  146</span><span class="comment">   * The post-condition is that the worker thread has fully and gracefully exited.</span></div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno">  147</span><span class="comment">   *</span></div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno">  148</span><span class="comment">   * Upon return from this method, any further `post()` or more complex async ops can safely be invoked -- but they</span></div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno">  149</span><span class="comment">   * will not do any actual work, and no tasks or completion handlers will run until start().  In particular</span></div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno">  150</span><span class="comment">   * task_engine() will still return a util::Task_engine, and one can still invoke `post()` and async I/O ops on it:</span></div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno">  151</span><span class="comment">   * doing so won&#39;t crash, but it won&#39;t do the requested work until start(). (Recall that there is no more</span></div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno">  152</span><span class="comment">   * threads in which to do this work.)  The destructor can then be invoked, at which point obviously one cannot</span></div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno">  153</span><span class="comment">   * `post()` (or anything else like it) either.</span></div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno">  154</span><span class="comment">   *</span></div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno">  155</span><span class="comment">   * This condition is reversible via start().  In fact, `*this` starts in the stopped state, and start() is required</span></div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno">  156</span><span class="comment">   * to make posted tasks actually execute.</span></div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno">  157</span><span class="comment">   *</span></div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno">  158</span><span class="comment">   * Lastly, calling stop() after stop() returns is a harmless no-op.  Also note the destructor shall call stop().</span></div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno">  159</span><span class="comment">   *</span></div>
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno">  160</span><span class="comment">   * ### Thread safety ###</span></div>
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno">  161</span><span class="comment">   * As noted in the class doc header, all methods are thread-safe on a common `*this` unless noted otherwise.</span></div>
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno">  162</span><span class="comment">   * To wit: it is not safe to call `X.stop()` concurrently with `X.stop()` or with `X.start()`.</span></div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno">  163</span><span class="comment">   *</span></div>
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno">  164</span><span class="comment">   * You may call stop() from within a task/completion handler executing within `*this` thread.  Of course</span></div>
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno">  165</span><span class="comment">   * you may also do this from another thread.</span></div>
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno">  166</span><span class="comment">   *</span></div>
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno">  167</span><span class="comment">   * ### Rationale ###</span></div>
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno">  168</span><span class="comment">   * See Concurrent_thread_task_loop::stop() doc header&#39;s Rationale section.  It also lists some useful tip(s) as of</span></div>
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno">  169</span><span class="comment">   * this writing.</span></div>
<div class="line"><a id="l00170" name="l00170"></a><span class="lineno">  170</span><span class="comment">   */</span></div>
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno">  171</span>  <span class="keywordtype">void</span> <a class="code hl_function" href="classflow_1_1async_1_1Single__thread__task__loop.html#aad1053b2d86401d34fd3658630064135">stop</a>();</div>
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno">  172</span><span class="comment"></span> </div>
<div class="line"><a id="l00173" name="l00173"></a><span class="lineno">  173</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00174" name="l00174"></a><span class="lineno">  174</span><span class="comment">   * Cause the given `Task` (function) to execute within the worker thread as soon as the thread is free of other queued</span></div>
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno">  175</span><span class="comment">   * tasks/completion handlers, in first-come-first-served fashion.  `task` may not execute concurrently with some other</span></div>
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno">  176</span><span class="comment">   * `Task`.</span></div>
<div class="line"><a id="l00177" name="l00177"></a><span class="lineno">  177</span><span class="comment">   *</span></div>
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno">  178</span><span class="comment">   * `synchronicity` controls the precise behavior of the &quot;post&quot; operation.  Read #Synchronicity `enum` docs carefully.</span></div>
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno">  179</span><span class="comment">   * That said: if left defaulted, `post()` works in the `post(Task_engine&amp;)` manner: return immediately; then</span></div>
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno">  180</span><span class="comment">   * execute either concurrently in another thread (if called *not* from within another in-thread task) or later in the</span></div>
<div class="line"><a id="l00181" name="l00181"></a><span class="lineno">  181</span><span class="comment">   * same thread (otherwise).</span></div>
<div class="line"><a id="l00182" name="l00182"></a><span class="lineno">  182</span><span class="comment">   *</span></div>
<div class="line"><a id="l00183" name="l00183"></a><span class="lineno">  183</span><span class="comment">   * This is safe to call after stop(), but `task()` will not run until start() (see stop() doc header).</span></div>
<div class="line"><a id="l00184" name="l00184"></a><span class="lineno">  184</span><span class="comment">   * Synchronicity::S_ASYNC_AND_AWAIT_CONCURRENT_COMPLETION and Synchronicity::S_ASYNC_AND_AWAIT_CONCURRENT_START modes</span></div>
<div class="line"><a id="l00185" name="l00185"></a><span class="lineno">  185</span><span class="comment">   * will, therefore, block infinitely in that case; so don&#39;t do that after stop().</span></div>
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno">  186</span><span class="comment">   *</span></div>
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno">  187</span><span class="comment">   * Reminder: This is thread-safe as explained in class doc header.</span></div>
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno">  188</span><span class="comment">   *</span></div>
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno">  189</span><span class="comment">   * ### Rationale notes ###</span></div>
<div class="line"><a id="l00190" name="l00190"></a><span class="lineno">  190</span><span class="comment">   * The callback arg would normally be the last arg, by Flow coding style.  In this case it isn&#39;t, because</span></div>
<div class="line"><a id="l00191" name="l00191"></a><span class="lineno">  191</span><span class="comment">   * it is more valuable to make `synchronicity` optional (which it can only be if it&#39;s the last arg).</span></div>
<div class="line"><a id="l00192" name="l00192"></a><span class="lineno">  192</span><span class="comment">   *</span></div>
<div class="line"><a id="l00193" name="l00193"></a><span class="lineno">  193</span><span class="comment">   * Also, `using` would be nice for brevity, but we don&#39;t want to expose the other (irrelevant) `post()` overload</span></div>
<div class="line"><a id="l00194" name="l00194"></a><span class="lineno">  194</span><span class="comment">   * of the `private` superclass.</span></div>
<div class="line"><a id="l00195" name="l00195"></a><span class="lineno">  195</span><span class="comment">   *</span></div>
<div class="line"><a id="l00196" name="l00196"></a><span class="lineno">  196</span><span class="comment">   * @param task</span></div>
<div class="line"><a id="l00197" name="l00197"></a><span class="lineno">  197</span><span class="comment">   *        Task to execute.  `task` object itself may be `move`d and saved.</span></div>
<div class="line"><a id="l00198" name="l00198"></a><span class="lineno">  198</span><span class="comment">   * @param synchronicity</span></div>
<div class="line"><a id="l00199" name="l00199"></a><span class="lineno">  199</span><span class="comment">   *        Controls when `task()` will execute particularly in relation to when this `post()` call returns.</span></div>
<div class="line"><a id="l00200" name="l00200"></a><span class="lineno">  200</span><span class="comment">   */</span></div>
<div class="line"><a id="l00201" name="l00201"></a><span class="lineno">  201</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classflow_1_1async_1_1Single__thread__task__loop.html#adaf7dbd5fbd6ee7c886daabc7a6ad0ae">post</a>(<a class="code hl_class" href="classflow_1_1Function.html">Task</a>&amp;&amp; task, <a class="code hl_enumeration" href="namespaceflow_1_1async.html#a0a06794b16b72f2829ce3353557c8485">Synchronicity</a> synchronicity = <a class="code hl_enumvalue" href="namespaceflow_1_1async.html#a0a06794b16b72f2829ce3353557c8485a4d7a5700444c0570af37b1f9bcc6eb1f">Synchronicity::S_ASYNC</a>);</div>
<div class="line"><a id="l00202" name="l00202"></a><span class="lineno">  202</span><span class="comment"></span> </div>
<div class="line"><a id="l00203" name="l00203"></a><span class="lineno">  203</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00204" name="l00204"></a><span class="lineno">  204</span><span class="comment">   * Equivalent to post() but execution is scheduled for later, after the given time period passes.</span></div>
<div class="line"><a id="l00205" name="l00205"></a><span class="lineno">  205</span><span class="comment">   *</span></div>
<div class="line"><a id="l00206" name="l00206"></a><span class="lineno">  206</span><span class="comment">   * The semantics are, in all ways in which this differs from post(), those of</span></div>
<div class="line"><a id="l00207" name="l00207"></a><span class="lineno">  207</span><span class="comment">   * util::schedule_task_from_now().  This includes the meaning of the returned value and the nature of</span></div>
<div class="line"><a id="l00208" name="l00208"></a><span class="lineno">  208</span><span class="comment">   * util::Scheduled_task.  Also, in particular, one can perform actions like canceling, short-firing, and</span></div>
<div class="line"><a id="l00209" name="l00209"></a><span class="lineno">  209</span><span class="comment">   * info-access by passing the returned handle into util::scheduled_task_cancel() and others.</span></div>
<div class="line"><a id="l00210" name="l00210"></a><span class="lineno">  210</span><span class="comment">   *</span></div>
<div class="line"><a id="l00211" name="l00211"></a><span class="lineno">  211</span><span class="comment">   * @warning You *must* not call any `util::scheduled_task_*()` function on the returned</span></div>
<div class="line"><a id="l00212" name="l00212"></a><span class="lineno">  212</span><span class="comment">   *          handle except from within `*this` loop&#39;s tasks.</span></div>
<div class="line"><a id="l00213" name="l00213"></a><span class="lineno">  213</span><span class="comment">   *</span></div>
<div class="line"><a id="l00214" name="l00214"></a><span class="lineno">  214</span><span class="comment">   * @todo Deal with the scheduled-tasks-affected-from-outside-loop corner case of the</span></div>
<div class="line"><a id="l00215" name="l00215"></a><span class="lineno">  215</span><span class="comment">   *       `Single_thread_task_loop::schedule_*()` APIs.  Perhaps add `bool in_loop_use_only` arg</span></div>
<div class="line"><a id="l00216" name="l00216"></a><span class="lineno">  216</span><span class="comment">   *       which, if `false`, will always disable the `single_threaded` optimization internally.</span></div>
<div class="line"><a id="l00217" name="l00217"></a><span class="lineno">  217</span><span class="comment">   *       At this time it always enables it which will cause thread un-safety if</span></div>
<div class="line"><a id="l00218" name="l00218"></a><span class="lineno">  218</span><span class="comment">   *       the returned handle is touched from outside an in-loop task.  `void` versions of the `schedule_*()` APIs</span></div>
<div class="line"><a id="l00219" name="l00219"></a><span class="lineno">  219</span><span class="comment">   *       should be added which would lack this, as in that case there is no handle to misuse outside the loop.</span></div>
<div class="line"><a id="l00220" name="l00220"></a><span class="lineno">  220</span><span class="comment">   *</span></div>
<div class="line"><a id="l00221" name="l00221"></a><span class="lineno">  221</span><span class="comment">   * @param from_now</span></div>
<div class="line"><a id="l00222" name="l00222"></a><span class="lineno">  222</span><span class="comment">   *        See util::schedule_task_from_now().</span></div>
<div class="line"><a id="l00223" name="l00223"></a><span class="lineno">  223</span><span class="comment">   * @param task</span></div>
<div class="line"><a id="l00224" name="l00224"></a><span class="lineno">  224</span><span class="comment">   *        The task to execute within `*this` unless successfully canceled.</span></div>
<div class="line"><a id="l00225" name="l00225"></a><span class="lineno">  225</span><span class="comment">   *        `task` object itself may be `move`d and saved.</span></div>
<div class="line"><a id="l00226" name="l00226"></a><span class="lineno">  226</span><span class="comment">   * @return See util::schedule_task_from_now().</span></div>
<div class="line"><a id="l00227" name="l00227"></a><span class="lineno">  227</span><span class="comment">   */</span></div>
<div class="line"><a id="l00228" name="l00228"></a><span class="lineno">  228</span>  <span class="keyword">virtual</span> <a class="code hl_typedef" href="namespaceflow_1_1util.html#aa0d10f5a906b3229f48979aa43e9ff7e">util::Scheduled_task_handle</a> <a class="code hl_function" href="classflow_1_1async_1_1Single__thread__task__loop.html#a2669021fe545a05ced370f09ce794f52">schedule_from_now</a>(<span class="keyword">const</span> <a class="code hl_typedef" href="namespaceflow.html#a48799f1263cdeedec125be51a3db2b79">Fine_duration</a>&amp; from_now, <a class="code hl_class" href="classflow_1_1Function.html">Scheduled_task</a>&amp;&amp; task);</div>
<div class="line"><a id="l00229" name="l00229"></a><span class="lineno">  229</span><span class="comment"></span> </div>
<div class="line"><a id="l00230" name="l00230"></a><span class="lineno">  230</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00231" name="l00231"></a><span class="lineno">  231</span><span class="comment">   * Equivalent to schedule_from_now() except one specifies an absolute time point instead of wait duration.</span></div>
<div class="line"><a id="l00232" name="l00232"></a><span class="lineno">  232</span><span class="comment">   *</span></div>
<div class="line"><a id="l00233" name="l00233"></a><span class="lineno">  233</span><span class="comment">   * @warning See schedule_from_now() warning.</span></div>
<div class="line"><a id="l00234" name="l00234"></a><span class="lineno">  234</span><span class="comment">   *</span></div>
<div class="line"><a id="l00235" name="l00235"></a><span class="lineno">  235</span><span class="comment">   * @param at</span></div>
<div class="line"><a id="l00236" name="l00236"></a><span class="lineno">  236</span><span class="comment">   *        See util::schedule_task_at().</span></div>
<div class="line"><a id="l00237" name="l00237"></a><span class="lineno">  237</span><span class="comment">   * @param task</span></div>
<div class="line"><a id="l00238" name="l00238"></a><span class="lineno">  238</span><span class="comment">   *        See schedule_from_now().</span></div>
<div class="line"><a id="l00239" name="l00239"></a><span class="lineno">  239</span><span class="comment">   * @return See schedule_from_now().</span></div>
<div class="line"><a id="l00240" name="l00240"></a><span class="lineno">  240</span><span class="comment">   */</span></div>
<div class="line"><a id="l00241" name="l00241"></a><span class="lineno">  241</span>  <span class="keyword">virtual</span> <a class="code hl_typedef" href="namespaceflow_1_1util.html#aa0d10f5a906b3229f48979aa43e9ff7e">util::Scheduled_task_handle</a> <a class="code hl_function" href="classflow_1_1async_1_1Single__thread__task__loop.html#a0fff7cd79132c92a03e46be93f7f53b8">schedule_at</a>(<span class="keyword">const</span> <a class="code hl_typedef" href="namespaceflow.html#a9d9cc2eeb10d398cff5591d446b763b8">Fine_time_pt</a>&amp; at, <a class="code hl_class" href="classflow_1_1Function.html">Scheduled_task</a>&amp;&amp; task);</div>
<div class="line"><a id="l00242" name="l00242"></a><span class="lineno">  242</span><span class="comment"></span> </div>
<div class="line"><a id="l00243" name="l00243"></a><span class="lineno">  243</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00244" name="l00244"></a><span class="lineno">  244</span><span class="comment">   * Returns a pointer to *the* internal util::Task_engine (a/k/a boost.asio `io_context`) for the purpose of</span></div>
<div class="line"><a id="l00245" name="l00245"></a><span class="lineno">  245</span><span class="comment">   * performing a boost.asio `async_*()` action on some boost.asio I/O object in the immediate near future.</span></div>
<div class="line"><a id="l00246" name="l00246"></a><span class="lineno">  246</span><span class="comment">   *</span></div>
<div class="line"><a id="l00247" name="l00247"></a><span class="lineno">  247</span><span class="comment">   * @return A mutable util::Task_engine to use soon.  It is *allowed* to use it as long as</span></div>
<div class="line"><a id="l00248" name="l00248"></a><span class="lineno">  248</span><span class="comment">   *         `*this` exists (pre-destructor) and even beyond that, though any use beyond that point would pass the</span></div>
<div class="line"><a id="l00249" name="l00249"></a><span class="lineno">  249</span><span class="comment">   *         reponsibility on providing thread(s) to `run()` in becomes the user&#39;s.</span></div>
<div class="line"><a id="l00250" name="l00250"></a><span class="lineno">  250</span><span class="comment">   */</span></div>
<div class="line"><a id="l00251" name="l00251"></a><span class="lineno">  251</span>  <a class="code hl_typedef" href="namespaceflow_1_1async.html#a968806f54b14c697fd76b3339a2bdbbf">Task_engine_ptr</a> <a class="code hl_function" href="classflow_1_1async_1_1Single__thread__task__loop.html#a324d656809aede5492a4767a4ee8cdf6">task_engine</a>();</div>
<div class="line"><a id="l00252" name="l00252"></a><span class="lineno">  252</span><span class="comment"></span> </div>
<div class="line"><a id="l00253" name="l00253"></a><span class="lineno">  253</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00254" name="l00254"></a><span class="lineno">  254</span><span class="comment">   * Returns `true` if and only if the thread executing this call is the thread started by start().</span></div>
<div class="line"><a id="l00255" name="l00255"></a><span class="lineno">  255</span><span class="comment">   * Returns `false` otherwise, including if start() has not yet been called.</span></div>
<div class="line"><a id="l00256" name="l00256"></a><span class="lineno">  256</span><span class="comment">   *</span></div>
<div class="line"><a id="l00257" name="l00257"></a><span class="lineno">  257</span><span class="comment">   * This may be useful if a task may be executed from an outside thread or posted through `*this` loop.</span></div>
<div class="line"><a id="l00258" name="l00258"></a><span class="lineno">  258</span><span class="comment">   * E.g., if `true` it can synchronously execute some other task; if `false` `post()` it</span></div>
<div class="line"><a id="l00259" name="l00259"></a><span class="lineno">  259</span><span class="comment">   * with Synchronicity::S_ASYNC_AND_AWAIT_CONCURRENT_START or Synchronicity::S_ASYNC_AND_AWAIT_CONCURRENT_COMPLETION</span></div>
<div class="line"><a id="l00260" name="l00260"></a><span class="lineno">  260</span><span class="comment">   * to ensure it not stoppable (by stop() or dtor) or even fully finishes synchronously, respectively.</span></div>
<div class="line"><a id="l00261" name="l00261"></a><span class="lineno">  261</span><span class="comment">   * Using either of those `Synchronicity` values while executing while in_thread() returns `true` assures</span></div>
<div class="line"><a id="l00262" name="l00262"></a><span class="lineno">  262</span><span class="comment">   * a thread hang instead.</span></div>
<div class="line"><a id="l00263" name="l00263"></a><span class="lineno">  263</span><span class="comment">   *</span></div>
<div class="line"><a id="l00264" name="l00264"></a><span class="lineno">  264</span><span class="comment">   * ### Thread safety ###</span></div>
<div class="line"><a id="l00265" name="l00265"></a><span class="lineno">  265</span><span class="comment">   * For a given `*this` safe to execute concurrently with any method except start().  It is also safe to execute</span></div>
<div class="line"><a id="l00266" name="l00266"></a><span class="lineno">  266</span><span class="comment">   * in the optional init-task given to start().</span></div>
<div class="line"><a id="l00267" name="l00267"></a><span class="lineno">  267</span><span class="comment">   *</span></div>
<div class="line"><a id="l00268" name="l00268"></a><span class="lineno">  268</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00269" name="l00269"></a><span class="lineno">  269</span><span class="comment">   */</span></div>
<div class="line"><a id="l00270" name="l00270"></a><span class="lineno">  270</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classflow_1_1async_1_1Single__thread__task__loop.html#ac282eacf6615eca207ce3cc74f419933">in_thread</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00271" name="l00271"></a><span class="lineno">  271</span> </div>
<div class="line"><a id="l00272" name="l00272"></a><span class="lineno">  272</span><span class="keyword">protected</span>:</div>
<div class="line"><a id="l00273" name="l00273"></a><span class="lineno">  273</span>  <span class="comment">// Methods.</span></div>
<div class="line"><a id="l00274" name="l00274"></a><span class="lineno">  274</span><span class="comment"></span> </div>
<div class="line"><a id="l00275" name="l00275"></a><span class="lineno">  275</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00276" name="l00276"></a><span class="lineno">  276</span><span class="comment">   * Returns the underlying work-horse Concurrent_task_loop.</span></div>
<div class="line"><a id="l00277" name="l00277"></a><span class="lineno">  277</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00278" name="l00278"></a><span class="lineno">  278</span><span class="comment">   */</span></div>
<div class="line"><a id="l00279" name="l00279"></a><span class="lineno">  279</span>  <a class="code hl_class" href="classflow_1_1async_1_1Concurrent__task__loop.html">Concurrent_task_loop</a>* <a class="code hl_function" href="classflow_1_1async_1_1Single__thread__task__loop.html#a73d3462ff7f1759382d33476b7257f16">underlying_loop</a>();</div>
<div class="line"><a id="l00280" name="l00280"></a><span class="lineno">  280</span> </div>
<div class="line"><a id="l00281" name="l00281"></a><span class="lineno">  281</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00282" name="l00282"></a><span class="lineno">  282</span>  <span class="comment">// Types.</span></div>
<div class="line"><a id="l00283" name="l00283"></a><span class="lineno">  283</span><span class="comment"></span> </div>
<div class="line"><a id="l00284" name="l00284"></a><span class="lineno">  284</span><span class="comment">  /// The class an instance of which we hold (in HAS-A fashion, not IS-A fashion).</span></div>
<div class="line"><a id="l00285" name="l00285"></a><span class="lineno"><a class="line" href="classflow_1_1async_1_1Single__thread__task__loop.html#abdd1cc1ee5fa01740bfccd5bdacac7ac">  285</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_class" href="classflow_1_1async_1_1Cross__thread__task__loop.html">Task_loop_impl</a> = <a class="code hl_class" href="classflow_1_1async_1_1Cross__thread__task__loop.html">Cross_thread_task_loop</a>;</div>
<div class="line"><a id="l00286" name="l00286"></a><span class="lineno">  286</span> </div>
<div class="line"><a id="l00287" name="l00287"></a><span class="lineno">  287</span>  <span class="comment">// Data.</span></div>
<div class="line"><a id="l00288" name="l00288"></a><span class="lineno">  288</span><span class="comment"></span> </div>
<div class="line"><a id="l00289" name="l00289"></a><span class="lineno">  289</span><span class="comment">  /// See underlying_loop().</span></div>
<div class="line"><a id="l00290" name="l00290"></a><span class="lineno"><a class="line" href="classflow_1_1async_1_1Single__thread__task__loop.html#a1d33d207f5e0e7479a00046ace7e54a4">  290</a></span><span class="comment"></span>  <a class="code hl_class" href="classflow_1_1async_1_1Cross__thread__task__loop.html">Task_loop_impl</a> <a class="code hl_variable" href="classflow_1_1async_1_1Single__thread__task__loop.html#a1d33d207f5e0e7479a00046ace7e54a4">m_underlying_loop</a>;</div>
<div class="line"><a id="l00291" name="l00291"></a><span class="lineno">  291</span><span class="comment"></span> </div>
<div class="line"><a id="l00292" name="l00292"></a><span class="lineno">  292</span><span class="comment">  /// Before start() it is default-cted (not-a-thread); from start() on it&#39;s the started thread&#39;s ID.</span></div>
<div class="line"><a id="l00293" name="l00293"></a><span class="lineno"><a class="line" href="classflow_1_1async_1_1Single__thread__task__loop.html#a5041ca2eba3b58b03ba09a48c938be05">  293</a></span><span class="comment"></span>  <a class="code hl_typedef" href="namespaceflow_1_1util.html#a0a4e7b2d3107bd630e0dc0c0b8f2e4de">util::Thread_id</a> <a class="code hl_variable" href="classflow_1_1async_1_1Single__thread__task__loop.html#a5041ca2eba3b58b03ba09a48c938be05">m_started_thread_id_or_none</a>;</div>
<div class="line"><a id="l00294" name="l00294"></a><span class="lineno">  294</span>}; <span class="comment">// class Single_thread_task_loop</span></div>
<div class="line"><a id="l00295" name="l00295"></a><span class="lineno">  295</span><span class="comment"></span> </div>
<div class="line"><a id="l00296" name="l00296"></a><span class="lineno">  296</span><span class="comment">/**</span></div>
<div class="line"><a id="l00297" name="l00297"></a><span class="lineno">  297</span><span class="comment"> * Identical to Single_thread_task_loop, but all tasks posted through it are automatically timed, with the result</span></div>
<div class="line"><a id="l00298" name="l00298"></a><span class="lineno">  298</span><span class="comment"> * accessible via accumulated_time().</span></div>
<div class="line"><a id="l00299" name="l00299"></a><span class="lineno">  299</span><span class="comment"> *</span></div>
<div class="line"><a id="l00300" name="l00300"></a><span class="lineno">  300</span><span class="comment"> * Using a Timed_single_thread_task_loop is identical to using Single_thread_task_loop; except -- as with</span></div>
<div class="line"><a id="l00301" name="l00301"></a><span class="lineno">  301</span><span class="comment"> * a Timed_concurrent_task_loop vs. plain Concurrent_task_loop -- any &quot;naked&quot; handler `F` passed directly to</span></div>
<div class="line"><a id="l00302" name="l00302"></a><span class="lineno">  302</span><span class="comment"> * a boost.asio `async_...(..., F)` operation should be wrapped by asio_handler_timed(), so that it too is timed.</span></div>
<div class="line"><a id="l00303" name="l00303"></a><span class="lineno">  303</span><span class="comment"> * Hence it would become: `async_...(..., L-&gt;asio_handler_timed(F))`.</span></div>
<div class="line"><a id="l00304" name="l00304"></a><span class="lineno">  304</span><span class="comment"> *</span></div>
<div class="line"><a id="l00305" name="l00305"></a><span class="lineno">  305</span><span class="comment"> * To access timing results use added API accumulated_time().</span></div>
<div class="line"><a id="l00306" name="l00306"></a><span class="lineno">  306</span><span class="comment"> */</span></div>
<div class="line"><a id="l00307" name="l00307"></a><span class="lineno"><a class="line" href="classflow_1_1async_1_1Timed__single__thread__task__loop.html">  307</a></span><span class="keyword">class </span><a class="code hl_class" href="classflow_1_1async_1_1Timed__single__thread__task__loop.html">Timed_single_thread_task_loop</a> : <span class="keyword">public</span> <a class="code hl_class" href="classflow_1_1async_1_1Single__thread__task__loop.html">Single_thread_task_loop</a></div>
<div class="line"><a id="l00308" name="l00308"></a><span class="lineno">  308</span>{</div>
<div class="line"><a id="l00309" name="l00309"></a><span class="lineno">  309</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00310" name="l00310"></a><span class="lineno">  310</span>  <span class="comment">// Constructors/destructor.</span></div>
<div class="line"><a id="l00311" name="l00311"></a><span class="lineno">  311</span><span class="comment"></span> </div>
<div class="line"><a id="l00312" name="l00312"></a><span class="lineno">  312</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00313" name="l00313"></a><span class="lineno">  313</span><span class="comment">   * Constructs object, similarly to Single_thread_task_loop ctor; but with timing capabilities</span></div>
<div class="line"><a id="l00314" name="l00314"></a><span class="lineno">  314</span><span class="comment">   * a-la Timed_concurrent_task_loop ctor.</span></div>
<div class="line"><a id="l00315" name="l00315"></a><span class="lineno">  315</span><span class="comment">   *</span></div>
<div class="line"><a id="l00316" name="l00316"></a><span class="lineno">  316</span><span class="comment">   * @param logger_ptr</span></div>
<div class="line"><a id="l00317" name="l00317"></a><span class="lineno">  317</span><span class="comment">   *        See Single_thread_task_loop ctor.</span></div>
<div class="line"><a id="l00318" name="l00318"></a><span class="lineno">  318</span><span class="comment">   * @param nickname</span></div>
<div class="line"><a id="l00319" name="l00319"></a><span class="lineno">  319</span><span class="comment">   *        See Single_thread_task_loop ctor.</span></div>
<div class="line"><a id="l00320" name="l00320"></a><span class="lineno">  320</span><span class="comment">   * @param clock_type</span></div>
<div class="line"><a id="l00321" name="l00321"></a><span class="lineno">  321</span><span class="comment">   *        See Timed_concurrent_task_loop_impl ctor.</span></div>
<div class="line"><a id="l00322" name="l00322"></a><span class="lineno">  322</span><span class="comment">   */</span></div>
<div class="line"><a id="l00323" name="l00323"></a><span class="lineno">  323</span>  <span class="keyword">explicit</span> <a class="code hl_function" href="classflow_1_1async_1_1Timed__single__thread__task__loop.html#a0318c7769d31232ec7b0c0ad0d8ad88f">Timed_single_thread_task_loop</a>(<a class="code hl_class" href="classflow_1_1log_1_1Logger.html">log::Logger</a>* logger_ptr, <a class="code hl_typedef" href="namespaceflow_1_1util.html#ae4dc52186797094b3040379ff19124c9">util::String_view</a> nickname,</div>
<div class="line"><a id="l00324" name="l00324"></a><span class="lineno">  324</span>                                         <a class="code hl_enumeration" href="namespaceflow_1_1perf.html#ad61fb186191e4bb824d14601d11a2eb0">perf::Clock_type</a> clock_type = <a class="code hl_enumvalue" href="namespaceflow_1_1perf.html#ad61fb186191e4bb824d14601d11a2eb0a93867c73fb6ef991268c0052153344c2">perf::Clock_type::S_CPU_THREAD_TOTAL_HI_RES</a>);</div>
<div class="line"><a id="l00325" name="l00325"></a><span class="lineno">  325</span> </div>
<div class="line"><a id="l00326" name="l00326"></a><span class="lineno">  326</span>  <span class="comment">// Methods.</span></div>
<div class="line"><a id="l00327" name="l00327"></a><span class="lineno">  327</span><span class="comment"></span> </div>
<div class="line"><a id="l00328" name="l00328"></a><span class="lineno">  328</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00329" name="l00329"></a><span class="lineno">  329</span><span class="comment">   * Implements superclass method but with the addition of timing of `task`, accessible through</span></div>
<div class="line"><a id="l00330" name="l00330"></a><span class="lineno">  330</span><span class="comment">   * accumulated_time().</span></div>
<div class="line"><a id="l00331" name="l00331"></a><span class="lineno">  331</span><span class="comment">   *</span></div>
<div class="line"><a id="l00332" name="l00332"></a><span class="lineno">  332</span><span class="comment">   * @see Single_thread_task_loop::post() doc header for the essential documentation outside of timing.</span></div>
<div class="line"><a id="l00333" name="l00333"></a><span class="lineno">  333</span><span class="comment">   *</span></div>
<div class="line"><a id="l00334" name="l00334"></a><span class="lineno">  334</span><span class="comment">   * @param task</span></div>
<div class="line"><a id="l00335" name="l00335"></a><span class="lineno">  335</span><span class="comment">   *        See superclass method.</span></div>
<div class="line"><a id="l00336" name="l00336"></a><span class="lineno">  336</span><span class="comment">   * @param synchronicity</span></div>
<div class="line"><a id="l00337" name="l00337"></a><span class="lineno">  337</span><span class="comment">   *        See superclass method.</span></div>
<div class="line"><a id="l00338" name="l00338"></a><span class="lineno">  338</span><span class="comment">   */</span></div>
<div class="line"><a id="l00339" name="l00339"></a><span class="lineno">  339</span>  <span class="keywordtype">void</span> <a class="code hl_function" href="classflow_1_1async_1_1Timed__single__thread__task__loop.html#aafc6c8e2d94c5387bfd4e49795244feb">post</a>(<a class="code hl_class" href="classflow_1_1Function.html">Task</a>&amp;&amp; task, <a class="code hl_enumeration" href="namespaceflow_1_1async.html#a0a06794b16b72f2829ce3353557c8485">Synchronicity</a> synchronicity = <a class="code hl_enumvalue" href="namespaceflow_1_1async.html#a0a06794b16b72f2829ce3353557c8485a4d7a5700444c0570af37b1f9bcc6eb1f">Synchronicity::S_ASYNC</a>) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00340" name="l00340"></a><span class="lineno">  340</span><span class="comment"></span> </div>
<div class="line"><a id="l00341" name="l00341"></a><span class="lineno">  341</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00342" name="l00342"></a><span class="lineno">  342</span><span class="comment">   * Implements superclass method but with the addition of timing of `task`, accessible through</span></div>
<div class="line"><a id="l00343" name="l00343"></a><span class="lineno">  343</span><span class="comment">   * accumulated_time().</span></div>
<div class="line"><a id="l00344" name="l00344"></a><span class="lineno">  344</span><span class="comment">   *</span></div>
<div class="line"><a id="l00345" name="l00345"></a><span class="lineno">  345</span><span class="comment">   * @see Single_thread_task_loop::schedule_from_now() doc header for the essential documentation outside of timing.</span></div>
<div class="line"><a id="l00346" name="l00346"></a><span class="lineno">  346</span><span class="comment">   *</span></div>
<div class="line"><a id="l00347" name="l00347"></a><span class="lineno">  347</span><span class="comment">   * @param from_now</span></div>
<div class="line"><a id="l00348" name="l00348"></a><span class="lineno">  348</span><span class="comment">   *        See superclass method.</span></div>
<div class="line"><a id="l00349" name="l00349"></a><span class="lineno">  349</span><span class="comment">   * @param task</span></div>
<div class="line"><a id="l00350" name="l00350"></a><span class="lineno">  350</span><span class="comment">   *        See superclass method.</span></div>
<div class="line"><a id="l00351" name="l00351"></a><span class="lineno">  351</span><span class="comment">   * @return See superclass method.</span></div>
<div class="line"><a id="l00352" name="l00352"></a><span class="lineno">  352</span><span class="comment">   */</span></div>
<div class="line"><a id="l00353" name="l00353"></a><span class="lineno">  353</span>  <a class="code hl_typedef" href="namespaceflow_1_1util.html#aa0d10f5a906b3229f48979aa43e9ff7e">util::Scheduled_task_handle</a> <a class="code hl_function" href="classflow_1_1async_1_1Timed__single__thread__task__loop.html#afed368e611529a648a7dd2999a89ab0d">schedule_from_now</a>(<span class="keyword">const</span> <a class="code hl_typedef" href="namespaceflow.html#a48799f1263cdeedec125be51a3db2b79">Fine_duration</a>&amp; from_now, <a class="code hl_class" href="classflow_1_1Function.html">Scheduled_task</a>&amp;&amp; task) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00354" name="l00354"></a><span class="lineno">  354</span><span class="comment"></span> </div>
<div class="line"><a id="l00355" name="l00355"></a><span class="lineno">  355</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00356" name="l00356"></a><span class="lineno">  356</span><span class="comment">   * Implements superclass method but with the addition of timing of `task`, accessible through</span></div>
<div class="line"><a id="l00357" name="l00357"></a><span class="lineno">  357</span><span class="comment">   * accumulated_time().</span></div>
<div class="line"><a id="l00358" name="l00358"></a><span class="lineno">  358</span><span class="comment">   *</span></div>
<div class="line"><a id="l00359" name="l00359"></a><span class="lineno">  359</span><span class="comment">   * @see Single_thread_task_loop::schedule_at() doc header for the essential documentation outside of timing.</span></div>
<div class="line"><a id="l00360" name="l00360"></a><span class="lineno">  360</span><span class="comment">   *</span></div>
<div class="line"><a id="l00361" name="l00361"></a><span class="lineno">  361</span><span class="comment">   * @param at</span></div>
<div class="line"><a id="l00362" name="l00362"></a><span class="lineno">  362</span><span class="comment">   *        See superclass method.</span></div>
<div class="line"><a id="l00363" name="l00363"></a><span class="lineno">  363</span><span class="comment">   * @param task</span></div>
<div class="line"><a id="l00364" name="l00364"></a><span class="lineno">  364</span><span class="comment">   *        See superclass method.</span></div>
<div class="line"><a id="l00365" name="l00365"></a><span class="lineno">  365</span><span class="comment">   * @return See superclass method.</span></div>
<div class="line"><a id="l00366" name="l00366"></a><span class="lineno">  366</span><span class="comment">   */</span></div>
<div class="line"><a id="l00367" name="l00367"></a><span class="lineno">  367</span>  <a class="code hl_typedef" href="namespaceflow_1_1util.html#aa0d10f5a906b3229f48979aa43e9ff7e">util::Scheduled_task_handle</a> <a class="code hl_function" href="classflow_1_1async_1_1Timed__single__thread__task__loop.html#a939142533e48fc54040825aad2010121">schedule_at</a>(<span class="keyword">const</span> <a class="code hl_typedef" href="namespaceflow.html#a9d9cc2eeb10d398cff5591d446b763b8">Fine_time_pt</a>&amp; at, <a class="code hl_class" href="classflow_1_1Function.html">Scheduled_task</a>&amp;&amp; task) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00368" name="l00368"></a><span class="lineno">  368</span><span class="comment"></span> </div>
<div class="line"><a id="l00369" name="l00369"></a><span class="lineno">  369</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00370" name="l00370"></a><span class="lineno">  370</span><span class="comment">   * See Timed_concurrent_task_loop_impl::accumulated_time().</span></div>
<div class="line"><a id="l00371" name="l00371"></a><span class="lineno">  371</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00372" name="l00372"></a><span class="lineno">  372</span><span class="comment">   */</span></div>
<div class="line"><a id="l00373" name="l00373"></a><span class="lineno">  373</span>  <a class="code hl_typedef" href="namespaceflow_1_1perf.html#a38e42ae0923eb23052e3a8a1e7956456">perf::Duration</a> <a class="code hl_function" href="classflow_1_1async_1_1Timed__single__thread__task__loop.html#ae429fb31d17d422306cd9da398e53e5c">accumulated_time</a>();</div>
<div class="line"><a id="l00374" name="l00374"></a><span class="lineno">  374</span><span class="comment"></span> </div>
<div class="line"><a id="l00375" name="l00375"></a><span class="lineno">  375</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00376" name="l00376"></a><span class="lineno">  376</span><span class="comment">   * See Timed_concurrent_task_loop_impl::asio_handler_timed().</span></div>
<div class="line"><a id="l00377" name="l00377"></a><span class="lineno">  377</span><span class="comment">   *</span></div>
<div class="line"><a id="l00378" name="l00378"></a><span class="lineno">  378</span><span class="comment">   * @tparam Handler</span></div>
<div class="line"><a id="l00379" name="l00379"></a><span class="lineno">  379</span><span class="comment">   *         See Timed_concurrent_task_loop_impl::asio_handler_timed().</span></div>
<div class="line"><a id="l00380" name="l00380"></a><span class="lineno">  380</span><span class="comment">   * @param handler_moved</span></div>
<div class="line"><a id="l00381" name="l00381"></a><span class="lineno">  381</span><span class="comment">   *        See Timed_concurrent_task_loop_impl::asio_handler_timed().</span></div>
<div class="line"><a id="l00382" name="l00382"></a><span class="lineno">  382</span><span class="comment">   * @return See Timed_concurrent_task_loop_impl::asio_handler_timed().</span></div>
<div class="line"><a id="l00383" name="l00383"></a><span class="lineno">  383</span><span class="comment">   */</span></div>
<div class="line"><a id="l00384" name="l00384"></a><span class="lineno">  384</span>  <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Handler&gt;</div>
<div class="line"><a id="l00385" name="l00385"></a><span class="lineno">  385</span>  <span class="keyword">auto</span> <a class="code hl_function" href="classflow_1_1async_1_1Timed__single__thread__task__loop.html#a37f2f0d5c163cc1d0b56213ebb080af0">asio_handler_timed</a>(Handler&amp;&amp; handler_moved);</div>
<div class="line"><a id="l00386" name="l00386"></a><span class="lineno">  386</span> </div>
<div class="line"><a id="l00387" name="l00387"></a><span class="lineno">  387</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00388" name="l00388"></a><span class="lineno">  388</span>  <span class="comment">// Data.</span></div>
<div class="line"><a id="l00389" name="l00389"></a><span class="lineno">  389</span><span class="comment"></span> </div>
<div class="line"><a id="l00390" name="l00390"></a><span class="lineno">  390</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00391" name="l00391"></a><span class="lineno">  391</span><span class="comment">   * The task-timing decorator of our superclass Single_thread_task_loop&#39;s `protected` superclass.</span></div>
<div class="line"><a id="l00392" name="l00392"></a><span class="lineno">  392</span><span class="comment">   * As required, its lifetime (being a base class) is &gt;= that of this decorating #m_timed_loop.</span></div>
<div class="line"><a id="l00393" name="l00393"></a><span class="lineno">  393</span><span class="comment">   */</span></div>
<div class="line"><a id="l00394" name="l00394"></a><span class="lineno"><a class="line" href="classflow_1_1async_1_1Timed__single__thread__task__loop.html#a3042959ca9c8f3d1bcd78ff71e3ecdd9">  394</a></span>  <a class="code hl_class" href="classflow_1_1async_1_1Timed__concurrent__task__loop__impl.html">Timed_concurrent_task_loop_impl&lt;perf::duration_rep_t&gt;</a> <a class="code hl_variable" href="classflow_1_1async_1_1Timed__single__thread__task__loop.html#a3042959ca9c8f3d1bcd78ff71e3ecdd9">m_timed_loop</a>;</div>
<div class="line"><a id="l00395" name="l00395"></a><span class="lineno">  395</span>}; <span class="comment">// class Timed_single_thread_task_loop</span></div>
<div class="line"><a id="l00396" name="l00396"></a><span class="lineno">  396</span> </div>
<div class="line"><a id="l00397" name="l00397"></a><span class="lineno">  397</span><span class="comment">// Template implementations.</span></div>
<div class="line"><a id="l00398" name="l00398"></a><span class="lineno">  398</span> </div>
<div class="line"><a id="l00399" name="l00399"></a><span class="lineno">  399</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Handler&gt;</div>
<div class="line"><a id="l00400" name="l00400"></a><span class="lineno"><a class="line" href="classflow_1_1async_1_1Timed__single__thread__task__loop.html#a37f2f0d5c163cc1d0b56213ebb080af0">  400</a></span><span class="keyword">auto</span> <a class="code hl_function" href="classflow_1_1async_1_1Timed__single__thread__task__loop.html#a37f2f0d5c163cc1d0b56213ebb080af0">Timed_single_thread_task_loop::asio_handler_timed</a>(Handler&amp;&amp; handler_moved)</div>
<div class="line"><a id="l00401" name="l00401"></a><span class="lineno">  401</span>{</div>
<div class="line"><a id="l00402" name="l00402"></a><span class="lineno">  402</span>  <span class="keywordflow">return</span> <a class="code hl_variable" href="classflow_1_1async_1_1Timed__single__thread__task__loop.html#a3042959ca9c8f3d1bcd78ff71e3ecdd9">m_timed_loop</a>.<a class="code hl_function" href="classflow_1_1async_1_1Timed__concurrent__task__loop__impl.html#a9e915ee364537114a9e2f50574d960b7">asio_handler_timed</a>(std::move(handler_moved));</div>
<div class="line"><a id="l00403" name="l00403"></a><span class="lineno">  403</span>}</div>
<div class="line"><a id="l00404" name="l00404"></a><span class="lineno">  404</span> </div>
<div class="line"><a id="l00405" name="l00405"></a><span class="lineno">  405</span>} <span class="comment">// namespace flow::async</span></div>
<div class="ttc" id="aasync__fwd_8hpp_html"><div class="ttname"><a href="async__fwd_8hpp.html">async_fwd.hpp</a></div></div>
<div class="ttc" id="aclassflow_1_1Function_html"><div class="ttname"><a href="classflow_1_1Function.html">flow::Function</a></div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00512">common.hpp:512</a></div></div>
<div class="ttc" id="aclassflow_1_1async_1_1Concurrent__task__loop_html"><div class="ttname"><a href="classflow_1_1async_1_1Concurrent__task__loop.html">flow::async::Concurrent_task_loop</a></div><div class="ttdoc">The core flow::async interface, providing an optionally multi-threaded thread pool onto which runnabl...</div><div class="ttdef"><b>Definition:</b> <a href="concurrent__task__loop_8hpp_source.html#l00322">concurrent_task_loop.hpp:324</a></div></div>
<div class="ttc" id="aclassflow_1_1async_1_1Cross__thread__task__loop_html"><div class="ttname"><a href="classflow_1_1async_1_1Cross__thread__task__loop.html">flow::async::Cross_thread_task_loop</a></div><div class="ttdoc">Concrete Concurrent_task_loop that is able to efficiently schedule Tasks within a given Op to execute...</div><div class="ttdef"><b>Definition:</b> <a href="x__thread__task__loop_8hpp_source.html#l00088">x_thread_task_loop.hpp:92</a></div></div>
<div class="ttc" id="aclassflow_1_1async_1_1Single__thread__task__loop_html"><div class="ttname"><a href="classflow_1_1async_1_1Single__thread__task__loop.html">flow::async::Single_thread_task_loop</a></div><div class="ttdoc">A Concurrent_task_loop-related adapter-style class that represents a single-thread task loop; essenti...</div><div class="ttdef"><b>Definition:</b> <a href="single__thread__task__loop_8hpp_source.html#l00075">single_thread_task_loop.hpp:78</a></div></div>
<div class="ttc" id="aclassflow_1_1async_1_1Single__thread__task__loop_html_a0886e7f19d0c8b19f74851578802a5e5"><div class="ttname"><a href="classflow_1_1async_1_1Single__thread__task__loop.html#a0886e7f19d0c8b19f74851578802a5e5">flow::async::Single_thread_task_loop::start</a></div><div class="ttdeci">void start(Task &amp;&amp;init_task_or_empty=Task())</div><div class="ttdoc">Starts the 1 thread in the thread pool; any queued post()ed (and similar) tasks may begin executing i...</div><div class="ttdef"><b>Definition:</b> <a href="single__thread__task__loop_8cpp_source.html#l00041">single_thread_task_loop.cpp:41</a></div></div>
<div class="ttc" id="aclassflow_1_1async_1_1Single__thread__task__loop_html_a0fff7cd79132c92a03e46be93f7f53b8"><div class="ttname"><a href="classflow_1_1async_1_1Single__thread__task__loop.html#a0fff7cd79132c92a03e46be93f7f53b8">flow::async::Single_thread_task_loop::schedule_at</a></div><div class="ttdeci">virtual util::Scheduled_task_handle schedule_at(const Fine_time_pt &amp;at, Scheduled_task &amp;&amp;task)</div><div class="ttdoc">Equivalent to schedule_from_now() except one specifies an absolute time point instead of wait duratio...</div><div class="ttdef"><b>Definition:</b> <a href="single__thread__task__loop_8cpp_source.html#l00072">single_thread_task_loop.cpp:72</a></div></div>
<div class="ttc" id="aclassflow_1_1async_1_1Single__thread__task__loop_html_a1d33d207f5e0e7479a00046ace7e54a4"><div class="ttname"><a href="classflow_1_1async_1_1Single__thread__task__loop.html#a1d33d207f5e0e7479a00046ace7e54a4">flow::async::Single_thread_task_loop::m_underlying_loop</a></div><div class="ttdeci">Task_loop_impl m_underlying_loop</div><div class="ttdoc">See underlying_loop().</div><div class="ttdef"><b>Definition:</b> <a href="single__thread__task__loop_8hpp_source.html#l00290">single_thread_task_loop.hpp:290</a></div></div>
<div class="ttc" id="aclassflow_1_1async_1_1Single__thread__task__loop_html_a2669021fe545a05ced370f09ce794f52"><div class="ttname"><a href="classflow_1_1async_1_1Single__thread__task__loop.html#a2669021fe545a05ced370f09ce794f52">flow::async::Single_thread_task_loop::schedule_from_now</a></div><div class="ttdeci">virtual util::Scheduled_task_handle schedule_from_now(const Fine_duration &amp;from_now, Scheduled_task &amp;&amp;task)</div><div class="ttdoc">Equivalent to post() but execution is scheduled for later, after the given time period passes.</div><div class="ttdef"><b>Definition:</b> <a href="single__thread__task__loop_8cpp_source.html#l00066">single_thread_task_loop.cpp:66</a></div></div>
<div class="ttc" id="aclassflow_1_1async_1_1Single__thread__task__loop_html_a324d656809aede5492a4767a4ee8cdf6"><div class="ttname"><a href="classflow_1_1async_1_1Single__thread__task__loop.html#a324d656809aede5492a4767a4ee8cdf6">flow::async::Single_thread_task_loop::task_engine</a></div><div class="ttdeci">Task_engine_ptr task_engine()</div><div class="ttdoc">Returns a pointer to the internal util::Task_engine (a/k/a boost.asio io_context) for the purpose of ...</div><div class="ttdef"><b>Definition:</b> <a href="single__thread__task__loop_8cpp_source.html#l00078">single_thread_task_loop.cpp:78</a></div></div>
<div class="ttc" id="aclassflow_1_1async_1_1Single__thread__task__loop_html_a5041ca2eba3b58b03ba09a48c938be05"><div class="ttname"><a href="classflow_1_1async_1_1Single__thread__task__loop.html#a5041ca2eba3b58b03ba09a48c938be05">flow::async::Single_thread_task_loop::m_started_thread_id_or_none</a></div><div class="ttdeci">util::Thread_id m_started_thread_id_or_none</div><div class="ttdoc">Before start() it is default-cted (not-a-thread); from start() on it's the started thread's ID.</div><div class="ttdef"><b>Definition:</b> <a href="single__thread__task__loop_8hpp_source.html#l00293">single_thread_task_loop.hpp:293</a></div></div>
<div class="ttc" id="aclassflow_1_1async_1_1Single__thread__task__loop_html_a73d3462ff7f1759382d33476b7257f16"><div class="ttname"><a href="classflow_1_1async_1_1Single__thread__task__loop.html#a73d3462ff7f1759382d33476b7257f16">flow::async::Single_thread_task_loop::underlying_loop</a></div><div class="ttdeci">Concurrent_task_loop * underlying_loop()</div><div class="ttdoc">Returns the underlying work-horse Concurrent_task_loop.</div><div class="ttdef"><b>Definition:</b> <a href="single__thread__task__loop_8cpp_source.html#l00083">single_thread_task_loop.cpp:83</a></div></div>
<div class="ttc" id="aclassflow_1_1async_1_1Single__thread__task__loop_html_a74f7b9eabdfc366e0a6fa46abbcf5047"><div class="ttname"><a href="classflow_1_1async_1_1Single__thread__task__loop.html#a74f7b9eabdfc366e0a6fa46abbcf5047">flow::async::Single_thread_task_loop::~Single_thread_task_loop</a></div><div class="ttdeci">~Single_thread_task_loop() override</div><div class="ttdoc">Executes stop() – see its doc header please – and then cleans up any resources.</div><div class="ttdef"><b>Definition:</b> <a href="single__thread__task__loop_8cpp_source.html#l00035">single_thread_task_loop.cpp:35</a></div></div>
<div class="ttc" id="aclassflow_1_1async_1_1Single__thread__task__loop_html_aad1053b2d86401d34fd3658630064135"><div class="ttname"><a href="classflow_1_1async_1_1Single__thread__task__loop.html#aad1053b2d86401d34fd3658630064135">flow::async::Single_thread_task_loop::stop</a></div><div class="ttdeci">void stop()</div><div class="ttdoc">Waits for the ongoing task/completion handler – if one is running – to return; then prevents any furt...</div><div class="ttdef"><b>Definition:</b> <a href="single__thread__task__loop_8cpp_source.html#l00056">single_thread_task_loop.cpp:56</a></div></div>
<div class="ttc" id="aclassflow_1_1async_1_1Single__thread__task__loop_html_ac282eacf6615eca207ce3cc74f419933"><div class="ttname"><a href="classflow_1_1async_1_1Single__thread__task__loop.html#ac282eacf6615eca207ce3cc74f419933">flow::async::Single_thread_task_loop::in_thread</a></div><div class="ttdeci">bool in_thread() const</div><div class="ttdoc">Returns true if and only if the thread executing this call is the thread started by start().</div><div class="ttdef"><b>Definition:</b> <a href="single__thread__task__loop_8cpp_source.html#l00051">single_thread_task_loop.cpp:51</a></div></div>
<div class="ttc" id="aclassflow_1_1async_1_1Single__thread__task__loop_html_adaf7dbd5fbd6ee7c886daabc7a6ad0ae"><div class="ttname"><a href="classflow_1_1async_1_1Single__thread__task__loop.html#adaf7dbd5fbd6ee7c886daabc7a6ad0ae">flow::async::Single_thread_task_loop::post</a></div><div class="ttdeci">virtual void post(Task &amp;&amp;task, Synchronicity synchronicity=Synchronicity::S_ASYNC)</div><div class="ttdoc">Cause the given Task (function) to execute within the worker thread as soon as the thread is free of ...</div><div class="ttdef"><b>Definition:</b> <a href="single__thread__task__loop_8cpp_source.html#l00061">single_thread_task_loop.cpp:61</a></div></div>
<div class="ttc" id="aclassflow_1_1async_1_1Single__thread__task__loop_html_aea2bba204b5d18c3f87d05a4ca19a13f"><div class="ttname"><a href="classflow_1_1async_1_1Single__thread__task__loop.html#aea2bba204b5d18c3f87d05a4ca19a13f">flow::async::Single_thread_task_loop::Single_thread_task_loop</a></div><div class="ttdeci">Single_thread_task_loop(log::Logger *logger_ptr, util::String_view nickname)</div><div class="ttdoc">Constructs object, making it available for post() and similar work, but without starting any thread a...</div><div class="ttdef"><b>Definition:</b> <a href="single__thread__task__loop_8cpp_source.html#l00026">single_thread_task_loop.cpp:26</a></div></div>
<div class="ttc" id="aclassflow_1_1async_1_1Timed__concurrent__task__loop__impl_html"><div class="ttname"><a href="classflow_1_1async_1_1Timed__concurrent__task__loop__impl.html">flow::async::Timed_concurrent_task_loop_impl&lt; perf::duration_rep_t &gt;</a></div></div>
<div class="ttc" id="aclassflow_1_1async_1_1Timed__concurrent__task__loop__impl_html_a9e915ee364537114a9e2f50574d960b7"><div class="ttname"><a href="classflow_1_1async_1_1Timed__concurrent__task__loop__impl.html#a9e915ee364537114a9e2f50574d960b7">flow::async::Timed_concurrent_task_loop_impl::asio_handler_timed</a></div><div class="ttdeci">auto asio_handler_timed(Handler &amp;&amp;handler_moved)</div><div class="ttdoc">Given a boost.asio completion handler handler for a boost.asio async_*() action on some boost....</div><div class="ttdef"><b>Definition:</b> <a href="timed__concurrent__task__loop_8hpp_source.html#l00392">timed_concurrent_task_loop.hpp:392</a></div></div>
<div class="ttc" id="aclassflow_1_1async_1_1Timed__single__thread__task__loop_html"><div class="ttname"><a href="classflow_1_1async_1_1Timed__single__thread__task__loop.html">flow::async::Timed_single_thread_task_loop</a></div><div class="ttdoc">Identical to Single_thread_task_loop, but all tasks posted through it are automatically timed,...</div><div class="ttdef"><b>Definition:</b> <a href="single__thread__task__loop_8hpp_source.html#l00307">single_thread_task_loop.hpp:308</a></div></div>
<div class="ttc" id="aclassflow_1_1async_1_1Timed__single__thread__task__loop_html_a0318c7769d31232ec7b0c0ad0d8ad88f"><div class="ttname"><a href="classflow_1_1async_1_1Timed__single__thread__task__loop.html#a0318c7769d31232ec7b0c0ad0d8ad88f">flow::async::Timed_single_thread_task_loop::Timed_single_thread_task_loop</a></div><div class="ttdeci">Timed_single_thread_task_loop(log::Logger *logger_ptr, util::String_view nickname, perf::Clock_type clock_type=perf::Clock_type::S_CPU_THREAD_TOTAL_HI_RES)</div><div class="ttdoc">Constructs object, similarly to Single_thread_task_loop ctor; but with timing capabilities a-la Timed...</div><div class="ttdef"><b>Definition:</b> <a href="single__thread__task__loop_8cpp_source.html#l00090">single_thread_task_loop.cpp:90</a></div></div>
<div class="ttc" id="aclassflow_1_1async_1_1Timed__single__thread__task__loop_html_a3042959ca9c8f3d1bcd78ff71e3ecdd9"><div class="ttname"><a href="classflow_1_1async_1_1Timed__single__thread__task__loop.html#a3042959ca9c8f3d1bcd78ff71e3ecdd9">flow::async::Timed_single_thread_task_loop::m_timed_loop</a></div><div class="ttdeci">Timed_concurrent_task_loop_impl&lt; perf::duration_rep_t &gt; m_timed_loop</div><div class="ttdoc">The task-timing decorator of our superclass Single_thread_task_loop's protected superclass.</div><div class="ttdef"><b>Definition:</b> <a href="single__thread__task__loop_8hpp_source.html#l00394">single_thread_task_loop.hpp:394</a></div></div>
<div class="ttc" id="aclassflow_1_1async_1_1Timed__single__thread__task__loop_html_a37f2f0d5c163cc1d0b56213ebb080af0"><div class="ttname"><a href="classflow_1_1async_1_1Timed__single__thread__task__loop.html#a37f2f0d5c163cc1d0b56213ebb080af0">flow::async::Timed_single_thread_task_loop::asio_handler_timed</a></div><div class="ttdeci">auto asio_handler_timed(Handler &amp;&amp;handler_moved)</div><div class="ttdoc">See Timed_concurrent_task_loop_impl::asio_handler_timed().</div><div class="ttdef"><b>Definition:</b> <a href="single__thread__task__loop_8hpp_source.html#l00400">single_thread_task_loop.hpp:400</a></div></div>
<div class="ttc" id="aclassflow_1_1async_1_1Timed__single__thread__task__loop_html_a939142533e48fc54040825aad2010121"><div class="ttname"><a href="classflow_1_1async_1_1Timed__single__thread__task__loop.html#a939142533e48fc54040825aad2010121">flow::async::Timed_single_thread_task_loop::schedule_at</a></div><div class="ttdeci">util::Scheduled_task_handle schedule_at(const Fine_time_pt &amp;at, Scheduled_task &amp;&amp;task) override</div><div class="ttdoc">Implements superclass method but with the addition of timing of task, accessible through accumulated_...</div><div class="ttdef"><b>Definition:</b> <a href="single__thread__task__loop_8cpp_source.html#l00112">single_thread_task_loop.cpp:112</a></div></div>
<div class="ttc" id="aclassflow_1_1async_1_1Timed__single__thread__task__loop_html_aafc6c8e2d94c5387bfd4e49795244feb"><div class="ttname"><a href="classflow_1_1async_1_1Timed__single__thread__task__loop.html#aafc6c8e2d94c5387bfd4e49795244feb">flow::async::Timed_single_thread_task_loop::post</a></div><div class="ttdeci">void post(Task &amp;&amp;task, Synchronicity synchronicity=Synchronicity::S_ASYNC) override</div><div class="ttdoc">Implements superclass method but with the addition of timing of task, accessible through accumulated_...</div><div class="ttdef"><b>Definition:</b> <a href="single__thread__task__loop_8cpp_source.html#l00101">single_thread_task_loop.cpp:101</a></div></div>
<div class="ttc" id="aclassflow_1_1async_1_1Timed__single__thread__task__loop_html_ae429fb31d17d422306cd9da398e53e5c"><div class="ttname"><a href="classflow_1_1async_1_1Timed__single__thread__task__loop.html#ae429fb31d17d422306cd9da398e53e5c">flow::async::Timed_single_thread_task_loop::accumulated_time</a></div><div class="ttdeci">perf::Duration accumulated_time()</div><div class="ttdoc">See Timed_concurrent_task_loop_impl::accumulated_time().</div><div class="ttdef"><b>Definition:</b> <a href="single__thread__task__loop_8cpp_source.html#l00117">single_thread_task_loop.cpp:117</a></div></div>
<div class="ttc" id="aclassflow_1_1async_1_1Timed__single__thread__task__loop_html_afed368e611529a648a7dd2999a89ab0d"><div class="ttname"><a href="classflow_1_1async_1_1Timed__single__thread__task__loop.html#afed368e611529a648a7dd2999a89ab0d">flow::async::Timed_single_thread_task_loop::schedule_from_now</a></div><div class="ttdeci">util::Scheduled_task_handle schedule_from_now(const Fine_duration &amp;from_now, Scheduled_task &amp;&amp;task) override</div><div class="ttdoc">Implements superclass method but with the addition of timing of task, accessible through accumulated_...</div><div class="ttdef"><b>Definition:</b> <a href="single__thread__task__loop_8cpp_source.html#l00106">single_thread_task_loop.cpp:107</a></div></div>
<div class="ttc" id="aclassflow_1_1log_1_1Log__context_html"><div class="ttname"><a href="classflow_1_1log_1_1Log__context.html">flow::log::Log_context</a></div><div class="ttdoc">Convenience class that simply stores a Logger and/or Component passed into a constructor; and returns...</div><div class="ttdef"><b>Definition:</b> <a href="log_8hpp_source.html#l01609">log.hpp:1610</a></div></div>
<div class="ttc" id="aclassflow_1_1log_1_1Logger_html"><div class="ttname"><a href="classflow_1_1log_1_1Logger.html">flow::log::Logger</a></div><div class="ttdoc">Interface that the user should implement, passing the implementing Logger into logging classes (Flow'...</div><div class="ttdef"><b>Definition:</b> <a href="log_8hpp_source.html#l01280">log.hpp:1284</a></div></div>
<div class="ttc" id="aclassflow_1_1util_1_1Null__interface_html"><div class="ttname"><a href="classflow_1_1util_1_1Null__interface.html">flow::util::Null_interface</a></div><div class="ttdoc">An empty interface, consisting of nothing but a default virtual destructor, intended as a boiler-plat...</div><div class="ttdef"><b>Definition:</b> <a href="util_2util_8hpp_source.html#l00044">util.hpp:45</a></div></div>
<div class="ttc" id="aclock__type__fwd_8hpp_html"><div class="ttname"><a href="clock__type__fwd_8hpp.html">clock_type_fwd.hpp</a></div></div>
<div class="ttc" id="anamespaceflow_1_1async_html"><div class="ttname"><a href="namespaceflow_1_1async.html">flow::async</a></div><div class="ttdoc">Flow module containing tools enabling multi-threaded event loops operating under the asynchronous-tas...</div><div class="ttdef"><b>Definition:</b> <a href="async__fwd_8hpp_source.html#l00074">async_fwd.hpp:75</a></div></div>
<div class="ttc" id="anamespaceflow_1_1async_html_a0a06794b16b72f2829ce3353557c8485"><div class="ttname"><a href="namespaceflow_1_1async.html#a0a06794b16b72f2829ce3353557c8485">flow::async::Synchronicity</a></div><div class="ttdeci">Synchronicity</div><div class="ttdoc">Enumeration indicating the manner in which asio_exec_ctx_post(), and various boost....</div><div class="ttdef"><b>Definition:</b> <a href="async__fwd_8hpp_source.html#l00222">async_fwd.hpp:223</a></div></div>
<div class="ttc" id="anamespaceflow_1_1async_html_a0a06794b16b72f2829ce3353557c8485a4d7a5700444c0570af37b1f9bcc6eb1f"><div class="ttname"><a href="namespaceflow_1_1async.html#a0a06794b16b72f2829ce3353557c8485a4d7a5700444c0570af37b1f9bcc6eb1f">flow::async::Synchronicity::S_ASYNC</a></div><div class="ttdeci">@ S_ASYNC</div><div class="ttdoc">Simply post the given task to execute asynchronously in some execution context – as soon as the conte...</div></div>
<div class="ttc" id="anamespaceflow_1_1async_html_a968806f54b14c697fd76b3339a2bdbbf"><div class="ttname"><a href="namespaceflow_1_1async.html#a968806f54b14c697fd76b3339a2bdbbf">flow::async::Task_engine_ptr</a></div><div class="ttdeci">boost::shared_ptr&lt; util::Task_engine &gt; Task_engine_ptr</div><div class="ttdoc">Short-hand for reference-counting pointer to a mutable util::Task_engine (a/k/a boost::asio::io_conte...</div><div class="ttdef"><b>Definition:</b> <a href="async__fwd_8hpp_source.html#l00198">async_fwd.hpp:198</a></div></div>
<div class="ttc" id="anamespaceflow_1_1async_html_af35fb65bdea1a3a92929ec2c4a6a6b72"><div class="ttname"><a href="namespaceflow_1_1async.html#af35fb65bdea1a3a92929ec2c4a6a6b72">flow::async::Task</a></div><div class="ttdeci">Function&lt; void()&gt; Task</div><div class="ttdoc">Short-hand for a task that can be posted for execution by a Concurrent_task_loop or flow::util::Task_...</div><div class="ttdef"><b>Definition:</b> <a href="async__fwd_8hpp_source.html#l00096">async_fwd.hpp:96</a></div></div>
<div class="ttc" id="anamespaceflow_1_1perf_html_a38e42ae0923eb23052e3a8a1e7956456"><div class="ttname"><a href="namespaceflow_1_1perf.html#a38e42ae0923eb23052e3a8a1e7956456">flow::perf::Duration</a></div><div class="ttdeci">Fine_duration Duration</div><div class="ttdoc">Short-hand for a high-precision boost.chrono duration, formally equivalent to flow::Fine_duration.</div><div class="ttdef"><b>Definition:</b> <a href="clock__type__fwd_8hpp_source.html#l00039">clock_type_fwd.hpp:39</a></div></div>
<div class="ttc" id="anamespaceflow_1_1perf_html_ad61fb186191e4bb824d14601d11a2eb0"><div class="ttname"><a href="namespaceflow_1_1perf.html#ad61fb186191e4bb824d14601d11a2eb0">flow::perf::Clock_type</a></div><div class="ttdeci">Clock_type</div><div class="ttdoc">Clock types supported by flow::perf module facilities, perf::Checkpointing_timer in particular.</div><div class="ttdef"><b>Definition:</b> <a href="clock__type__fwd_8hpp_source.html#l00066">clock_type_fwd.hpp:67</a></div></div>
<div class="ttc" id="anamespaceflow_1_1perf_html_ad61fb186191e4bb824d14601d11a2eb0a93867c73fb6ef991268c0052153344c2"><div class="ttname"><a href="namespaceflow_1_1perf.html#ad61fb186191e4bb824d14601d11a2eb0a93867c73fb6ef991268c0052153344c2">flow::perf::Clock_type::S_CPU_THREAD_TOTAL_HI_RES</a></div><div class="ttdeci">@ S_CPU_THREAD_TOTAL_HI_RES</div><div class="ttdoc">Similar to S_CPU_TOTAL_HI_RES but applied to the calling thread as opposed to entire process.</div></div>
<div class="ttc" id="anamespaceflow_1_1util_html_a0a4e7b2d3107bd630e0dc0c0b8f2e4de"><div class="ttname"><a href="namespaceflow_1_1util.html#a0a4e7b2d3107bd630e0dc0c0b8f2e4de">flow::util::Thread_id</a></div><div class="ttdeci">Thread::id Thread_id</div><div class="ttdoc">Short-hand for an OS-provided ID of a util::Thread.</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00090">util_fwd.hpp:90</a></div></div>
<div class="ttc" id="anamespaceflow_1_1util_html_aa0d10f5a906b3229f48979aa43e9ff7e"><div class="ttname"><a href="namespaceflow_1_1util.html#aa0d10f5a906b3229f48979aa43e9ff7e">flow::util::Scheduled_task_handle</a></div><div class="ttdeci">boost::shared_ptr&lt; Scheduled_task_handle_state &gt; Scheduled_task_handle</div><div class="ttdoc">Black-box type that represents a handle to a scheduled task as scheduled by schedule_task_at() or sch...</div><div class="ttdef"><b>Definition:</b> <a href="sched__task__fwd_8hpp_source.html#l00045">sched_task_fwd.hpp:45</a></div></div>
<div class="ttc" id="anamespaceflow_1_1util_html_ae4dc52186797094b3040379ff19124c9"><div class="ttname"><a href="namespaceflow_1_1util.html#ae4dc52186797094b3040379ff19124c9">flow::util::String_view</a></div><div class="ttdeci">Basic_string_view&lt; char &gt; String_view</div><div class="ttdoc">Commonly used char-based Basic_string_view. See its doc header.</div><div class="ttdef"><b>Definition:</b> <a href="string__view_8hpp_source.html#l00191">string_view.hpp:191</a></div></div>
<div class="ttc" id="anamespaceflow_html_a48799f1263cdeedec125be51a3db2b79"><div class="ttname"><a href="namespaceflow.html#a48799f1263cdeedec125be51a3db2b79">flow::Fine_duration</a></div><div class="ttdeci">Fine_clock::duration Fine_duration</div><div class="ttdoc">A high-res time duration as computed from two Fine_time_pts.</div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00416">common.hpp:416</a></div></div>
<div class="ttc" id="anamespaceflow_html_a9d9cc2eeb10d398cff5591d446b763b8"><div class="ttname"><a href="namespaceflow.html#a9d9cc2eeb10d398cff5591d446b763b8">flow::Fine_time_pt</a></div><div class="ttdeci">Fine_clock::time_point Fine_time_pt</div><div class="ttdoc">A high-res time point as returned by Fine_clock::now() and suitable for precise time math in general.</div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00413">common.hpp:413</a></div></div>
<div class="ttc" id="atimed__concurrent__task__loop_8hpp_html"><div class="ttname"><a href="timed__concurrent__task__loop_8hpp.html">timed_concurrent_task_loop.hpp</a></div></div>
<div class="ttc" id="autil_2util_8hpp_html"><div class="ttname"><a href="util_2util_8hpp.html">util.hpp</a></div></div>
<div class="ttc" id="ax__thread__task__loop_8hpp_html"><div class="ttname"><a href="x__thread__task__loop_8hpp.html">x_thread_task_loop.hpp</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Mar 28 2025 22:55:35 for Flow by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
